Overview Package Class Deprecated Help

pxc
PortCrossConnectSubPort

Represents Port Cross Connect SubPort information.

public class PortCrossConnectSubPort

Stats:
equipment.IngressPortFwdEngDropReasonStats equipment.InterfaceAdditionalStats equipment.InterfaceStats equipment.MediaIndependentStats equipment.PortEgressAggregateStats equipment.PortStats equipment.SubscrHostEquipPortStats ethernetequipment.AdditionalEthernetStats ethernetequipment.Dot3Stats ethernetequipment.EthernetHighCapacityStats ethernetequipment.EthernetStats

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

type=long
access=read-only
default=0
units=kbps
accessBandwidth Specifies the administrative access bandwidth assigned to this port.

type=long
default=0
minimum=0
maximum=3200000000
units=kbps
accessBookedBW Indicates the port access bandwidth that has been booked.

type=long
access=read-only
default=0
units=Percentage
accessBookingFactor Specifies the booking factor, applied as a percentage, against the administrative access bandwidth

type=long
default=100
minimum=1
maximum=1000
units=Percentage
clear.ClearRequest-Set type=Children-Set
egressAccessWeight

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

type=int
access=read-only
default=50
minimum=0
maximum=100
Displayed(tab/group)=Network Weight (/Hybrid Egress Buffer Allocation)
equipment.EgrSchVirtualPort-Set type=Children-Set
ethernetequipment.AccessEgrQGroup-Set type=Children-Set
ethernetequipment.AccessIngrQGroup-Set type=Children-Set
ethernetequipment.Dot3Oam-Set type=Children-Set
ethernetequipment.Dot3OamSfEventLogEntry-Set type=Children-Set
ethernetequipment.EthernetPortSpecifics-Set type=Children-Set
ethernetequipment.NetworkEgrQGroup-Set type=Children-Set
ingressAccessWeight

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

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

type=boolean
access=read-only
default=false
lagMembershipId

type=int
access=read-only
default=0
minimum=0
maximum=800
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 Egress Aggregate Queue Stats (/Stats)
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: pxc.PortCrossConnectSubPort.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)
netw.PhysicalInterfaceCtp-Set type=Children-Set
pxcId PxcId specifies the unique identifier of PXC to which this PortCrossConnectSubPort belongsto.

type=long
access=read-only
pxcSubPortId Specifies the Port Cross Connect SubPort identifier.

type=long
access=read-only
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 Out of Range
    0x2: channelNotConfigured - Channel Not Configured
    0x1: crcError - CRC Error
    0x8000: internalMacTxError - Internal MAC Tx Error
    0x4000: efmOamDown - OAM EFM is Down
service.OperGrpBindingMonitor-Set type=Children-Set
subPortSnmpId snmpPortId specifies the unique identifier of PXC to which this PortCrossConnectSubPort belongsto.

type=long
access=read-create
default=1
Displayed(tab/group)=Interface ID
  
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.

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
7750 SR Supported from 14.0.R1 until 14.0.R4
  • Excluded chassis types: 7750-SRc4, 7750-SRc12, VSR-I, VSR
Supported from 14.0.R4
  • Excluded chassis types: 7750-SRc4, 7750-SRc12
7705 SAR Gen 2
7705 SAR Hm
7450 ESS Supported from 14.0.R1
  • Excluded chassis types: 7450-ESS6, 7450-ESS6V
7950 XRS Supported from 14.0.R1
Product Specifics
7450 ESS 20.0
7450 ESS 21.0
7450 ESS 22.0
7450 ESS 23.0
7450 ESS 24.0
7450 ESS 25.0
7705 SAR Gen 2 25.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
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