ptp
IEEEPTPPeer

This class represents the configurations for IEEE 1588 PTP Parameters.



public class IEEEPTPPeer

Stats:
ptp.PTPPeerPacketStats ptp.PTPPeerPacketStatsExtends ptp.PTPStats ptp.PtpClockRecoveryAlgStats ptp.PtpClockRecoveryShortIntvlStats ptp.PtpClockRecoveryStats

Properties
announceDirection

type=ptp.PtpDirection
access=read-only
default=rx
Displayed(tab/group)=Announce Direction

bidirMonitoredIpPathPointer Pointer to the bidirectional monitored IP path for this Peer.

type=Pointer
default=
Displayed(tab/group)=Bidirectional IP Path Monitor (Path Monitoring)

clockIndex

type=int
default=0

creationOrigin

type=svt.L2RouteOriginType
access=read-create
default=manual

isSyncEEnabled

type=boolean
access=read-only
default=false
Displayed(tab/group)=Sync-E Enabled

monitoredIpPathPointer Pointer to the monitored IP path for this Peer.

type=Pointer
default=
Displayed(tab/group)=IP Path Monitor (Path Monitoring)

peerAdminState

type=ptp.AluPtpClockAdminState
default=inService
Displayed(tab/group)=Admin State

peerAlternateProfile

type=string
access=read-only
default=primary
Displayed(tab/group)=Profile Name

peerClockDomain

type=long
access=read-only
default=0
minimum=0
maximum=255
Displayed(tab/group)=Domain

peerClockId

type=string
access=read-only
Displayed(tab/group)=Peer Clock ID

peerClockLocalPortNumber

type=long
access=read-only
Displayed(tab/group)=Peer Clock Local Port Number

peerClockProfile Specifies the standard that defines the PTP features allowed on a device.

type=ptp.Alu1588PtpProfile
access=read-only
default=2
Displayed(tab/group)=PTP Profile

peerClockRemotePortNumber

type=long
access=read-only
Displayed(tab/group)=Peer Clock Remote Port Number

peerClockType

type=ptp.Alu1588PtpClockType
access=read-only
default=2
Displayed(tab/group)=Peer Clock Type

peerCurrentMaster

type=boolean
access=read-only
Displayed(tab/group)=Current Master (/Peer Master Status)

peerDescription

type=string
default=
maximum=80
Displayed(tab/group)=Peer Description

peerDiscovered

type=boolean
access=read-only
default=false
Displayed(tab/group)=Peer Discovered

peerDomain

type=long
access=read-only
default=0
minimum=0
maximum=127

peerId

type=int
access=read-create
default=0
minimum=1
maximum=10
Displayed(tab/group)=Peer Id

peerIndex

type=long
access=read-create
default=1

peerIpAddrType

type=rtr.InetAddressType
default=ipv4

valid enums=ipv4, ipv6, unknown (Where parent is one of (ptp.IEEEPTPPort, vprn.Site))
suppress enums=ipv6 (Where parent is one of (ptp.IEEEPTPPort, vprn.Site)) (until 23.3.R1)

peerIpAddress

type=InetAddress
default=0.0.0.0
Displayed(tab/group)=Peer IP Address

peerLastChanged

type=Date
access=read-only
default=0
Displayed(tab/group)=Peer Last Changed

peerLastRxPort

type=string
access=read-only
Displayed(tab/group)=Last Rx Port

peerLastTxPort

type=string
access=read-only
Displayed(tab/group)=Last Tx Port

peerMasterAlarm

type=ptp.PeerMasterAlarmBits
access=read-only
Displayed(tab/group)=Master GM Alarms (/Peer Master Status)

peerMasterBackup It shows whether a particular this port is a backup when the clock is using GNSS.

type=boolean
access=read-only
default=false
Displayed(tab/group)=Backup Source (/Peer Master Status)

peerMasterClockId

type=string
access=read-only
Displayed(tab/group)=Master Clock ID (/Peer Master Status)

peerMasterClockStepType

type=ptp.Alu1588PtpClockStepType
access=read-only
Displayed(tab/group)=Master Clock Step Type (/Peer Master Status)

peerMasterClockStepsRemoved

type=long
access=read-only
Displayed(tab/group)=Master Clock Steps Removed (/Peer Master Status)

peerMasterGMAccuracy

type=long
access=read-only
Displayed(tab/group)=Master GM Accuracy (/Peer Master Status)

peerMasterGMClass

type=long
access=read-only
Displayed(tab/group)=Master GM Class (/Peer Master Status)

peerMasterGMClockPriority1

type=long
access=read-only
Displayed(tab/group)=Master GM Clock Priority 1 (/Peer Master Status)

peerMasterGMClockPriority2

type=long
access=read-only
Displayed(tab/group)=Master GM Clock Priority 2 (/Peer Master Status)

peerMasterGMVariance

type=long
access=read-only
Displayed(tab/group)=Master GM Variance (/Peer Master Status)

peerPortState

type=ptp.TmnxPtpPortState
access=read-only
default=notApplicable
Displayed(tab/group)=Peer Port State

peerPriority

type=long
default=128
minimum=1
maximum=255
Displayed(tab/group)=Peer Priority

peerRemoteMaster

type=boolean
access=read-only
default=false
Displayed(tab/group)=Peer Remote Master

peerRemoteSiteId

type=string
access=read-only
default=0.0.0.0
maximum=64
Displayed(tab/group)=Peer Remote Site ID

peerRemoteSlave

type=boolean
access=read-only
default=false
Displayed(tab/group)=Peer Remote Slave

peerRxTimeStampPoint

type=ptp.PtpTimeStampReferencePoint
access=read-only
Displayed(tab/group)=Rx Timestamp Point

peerSyncCertainty It indicates the value of the synchronizationUncertain flag of the Announce message header recieved or transmitted by the peer.

type=ptp.SyncCertaintyState
access=read-only
default=unknown
Displayed(tab/group)=Peer Sync Certainty

peerTxTimeStampPoint

type=ptp.PtpTimeStampReferencePoint
access=read-only
Displayed(tab/group)=Tx Timestamp Point

portIndex

type=int
default=0

ptp.IEEEPTPPeerUnicast-Set type=Children-Set
ptpPeerSyncInterval

type=int
default=-6
minimum=-6
maximum=0
units=log base 2 seconds
Displayed(tab/group)=Peer Sync Interval

routerInfo Shows the Router Id of the Site (Base or VPRN)

type=string
access=read-only
default=Base(1)
Displayed(tab/group)=Router

sep1BidirMonitoredIpPathPointer Pointer to the bidirectional monitored IP path for the Peer IP Address and Source Entry Point 1.

type=Pointer
default=
Displayed(tab/group)=Source Entry Point 1 Bidirectional IP Path Monitor (Path Monitoring/Source Entry points)

sep1MonitoredIpPathPointer Pointer to the monitored IP path for the Peer IP Address and Source Entry Point 1.

type=Pointer
default=
Displayed(tab/group)=Source Entry Point 1 IP Path Monitor (Path Monitoring/Source Entry points)

sep2BidirMonitoredIpPathPointer Pointer to the bidirectional monitored IP path for the Peer IP Address and Source Entry Point 2.

type=Pointer
default=
Displayed(tab/group)=Source Entry Point 2 Bidirectional IP Path Monitor (Path Monitoring/Source Entry points)

sep2MonitoredIpPathPointer Pointer to the monitored IP path for the Peer IP Address and Source Entry Point 2.

type=Pointer
default=
Displayed(tab/group)=Source Entry Point 2 IP Path Monitor (Path Monitoring/Source Entry points)

sep3BidirMonitoredIpPathPointer Pointer to the bidirectional monitored IP path for the Peer IP Address and Source Entry Point 3.

type=Pointer
default=
Displayed(tab/group)=Source Entry Point 3 Bidirectional IP Path Monitor (Path Monitoring/Source Entry points)

sep3MonitoredIpPathPointer Pointer to the monitored IP path for the Peer IP Address and Source Entry Point 3.

type=Pointer
default=
Displayed(tab/group)=Source Entry Point 3 IP Path Monitor (Path Monitoring/Source Entry points)

sep4BidirMonitoredIpPathPointer Pointer to the bidirectional monitored IP path for the Peer IP Address and Source Entry Point 4.

type=Pointer
default=
Displayed(tab/group)=Source Entry Point 4 Bidirectional IP Path Monitor (Path Monitoring/Source Entry points)

sep4MonitoredIpPathPointer Pointer to the monitored IP path for the Peer IP Address and Source Entry Point 4.

type=Pointer
default=
Displayed(tab/group)=Source Entry Point 4 IP Path Monitor (Path Monitoring/Source Entry points)

siteId

type=string
access=read-only
default=0.0.0.0
maximum=50
Displayed(tab/group)=Peer Site ID

sourceEntryPointPointer Pointer to the source entry point.

type=Pointer
default=
Displayed(tab/group)=Source Entry Point

  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

resetPTPCounters

This method reset PTP Counters
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
Exceptions:
ptp.IEEEPTPPeer.resetPTPCountersException
Supported Network Elements
7705 SAR H
7705 SAR Supported from 4.0.R3
7210 SAS M Supported from 5.0.R1
7210 SAS T Supported from 6.0.R5
7210 SAS Mxp
7210 SAS R Supported from 7.0.R4
7210 SAS X Supported from 5.0.R3
7210 SAS D Supported from 5.0.R2
  • Excluded chassis types: 7210 SAS-D-6F-4T
7210 SAS K
7210 SAS S/Sx
7210 SAS Dxp Supported from 21.9.R1
  • Excluded chassis types: 7210 SAS-Dxp-6T-4F-2SFP
7750 SR Supported until 11.0.R4
  • Excluded chassis types: 7750-SR1, 7750-SRc12
Supported from 11.0.R4 until 13.0.R5
  • Excluded chassis types: 7750-SR1, 7750-SRa4, 7750-SRa8
Supported from 13.0.R5
7705 SAR Gen 2 Supported for all versions
  • Excluded chassis types: 7705 SAR-1
7450 ESS Supported from 9.0.R4
  • Excluded chassis types: 7450-ESS1, 7450-ESS6, 7450-ESS6V
Wavence SM Supported from 19.1.0
7950 XRS Supported from 14.0.R6
  • Excluded chassis types: 7950-XRS16
7250 IXR Supported from 19.5.R1
Product Specifics
7210 SAS D (all versions)
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 (all versions)
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 (all versions)
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 (all versions)
7210 SAS M 20.0
7210 SAS M 21.0
7210 SAS Mxp (all versions)
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 (all versions)
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 (all versions)
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 (all versions)
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
7210 SAS X (all versions)
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 (all versions)
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 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 20.0
7705 SAR 21.0
7705 SAR 22.0
7705 SAR 23.0
7705 SAR 24.0
7705 SAR 25.0
7750 SR (all versions)
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 (all versions)
7950 XRS 20.0
7950 XRS 21.0
7950 XRS 22.0
7950 XRS 23.0
7950 XRS 24.0
7950 XRS 25.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