calltrace
CallTraceJob

This object contains the Jobs created for Call-Trace. This is a read-only informational object.



public class CallTraceJob

Properties
capturedMessagesCount Specifies the number of events this call-trace job has generated so far.

type=long
access=read-only

capturedMessagesSize Specifies the total size of all messages this call-trace job has generated so far.

type=long
access=read-only

circuitId Specifies the circuit ID of the job being monitored by this call-trace job.

type=string
access=read-only

destinationAddress Specifies the live output destination address of the trace log generated by this call-trace job.

type=InetAddress
access=read-only

destinationAddressType Specifies the address type of destinationAddress.

type=rtr.InetAddressType
access=read-only

destinationPort Specifies the destination UDP port on the destination indicated by the value of the destinationAddress which the live output generated by this call-trace job is being sent to.

type=long
access=read-only

destinationRouterId Specifies the virtual router instance ID in scope of which the live output destination identified by the values of destinationAddress and destinationPort is to be reached.

type=long
access=read-only

destinationRouterType Specifies the identifier of the virtual router instance the domain associated with the live output destination.

type=calltrace.RouterType
access=read-only

destinationType Specifies the destination to which the logs generated by this call-trace job are stored.

type=calltrace.CallTraceDestinationType
access=read-only

destinationVprnPointer Identify a VPRN instance in the system. This attribute is used for NFM-P configuration only.

type=string
access=read-only
default=

ipoeIeeeAddr Specifies the IEEE address of the IPoE equipment being monitored by this call-trace job.

type=MacAddress
access=read-only

jobId Specifies the ID of the call-trace job.

type=long
access=read-create
Mandatory on create

jobStatus Specifies the status of the call-trace job. The value 'running (0)' indicates the job is active and is tracing events triggered by the host. The value 'finished (1)' indicates the job has already finished and is not tracing events generated by the host anymore. The job was terminated either due to reaching one of the defined limits or manual intervention of an operator.

type=calltrace.CallTraceJobStatus
access=read-only

jobType Specifies the ID of the call-trace job.

type=calltrace.CallTraceHostType
access=read-only
default=ipoe

remoteId Specifies the remote ID of the job being monitored by this call-trace job.

type=string
access=read-only

resolvedAddress Specifies the IP address, that the FQDN indicated by the value of the destination address was resolved into.

type=InetAddress
access=read-only

resolvedAddressType Specifies the address type of resolvedAddress.

type=rtr.InetAddressType
access=read-only

sapPointer Specifies the SAP of the job being monitored by this call-trace job.

type=string
access=read-only
default=

siteId

type=string
access=read-only
default=0.0.0.0
maximum=64

sizeLimit Specifies the maximum data volume generated by this call-trace job to an output in megabytes. If the call-trace job is 'running (0)' then the job will be automatically terminated after reaching this limit.

type=long
access=read-only
units=MB

startTime Specifies the time when this call-trace job has been started.

type=Date
access=read-only

timeLimit Specifies the maximum duration of this call-trace job in seconds. If the call-trace job is 'running (0)' then the job will be automatically terminated after reaching this limit.

type=long
access=read-only
units=seconds

traceName Specifies the name of the trace that triggered this call-trace job

type=string
access=read-only

traceProfilePointer Specifies the the call trace profile used to define job's parameters at the moment of creation of the job. Note: Current values of the trace profile's parameters may differ from their values at the moment of creation of the job.

type=string
access=read-only
default=

wlanGwUeIeeeAddr Specifies the IEEE address of the WLAN GW UE being monitored by this call-trace job.

type=MacAddress
access=read-only

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

retrieveCallTraceJobs

Retrieve call-trace jobs request with desired siteId, and (optional) ID, traceName, sapFdn, macAddress, circuitId, remoteId whose values are used to retrieve the call-trace jobs.
Input Parameters:
retrieveCallTraceStruct : calltrace.RetrieveCallTraceStruct - The retrievingCallTraceJobsStruct must have set siteId.
traceName : string - (Optional) Specifies the trace name. Its optional parameter.
sapFdn : string - (Optional) Specifies the FDN of SAP.Its optional parameter.
macAddress : string - (Optional) Specifies the MAC address of IPoE Session. Its optional parameter.
circuitId : string - (Optional) Specifies the circuit ID of IPoE Session. Its optional parameter.
remoteId : string - (Optional) Specifies the remote ID of IPoE Session. Its optional parameter.
timeout : long - (Optional) The number of milliseconds to wait before receiving the results. If no results are received in the given time, the method returns.
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:
result : List (generic.CommonManagedEntityInformation) -
Exceptions:
calltrace.CallTraceJob.retrieveCallTraceJobsException

retrieveWlanGwUeCallTraceJobs

Retrieve call-trace jobs request with desired siteId, and optional IEEE address, whose values are used to retrieve the call-trace jobs.
Input Parameters:
retrieveCallTraceStruct : calltrace.RetrieveCallTraceStruct - The retrievingCallTraceJobsStruct must have set siteId.
ieeeAddress : string - (Optional) Specifies the IEEE address of WLAN GW UE. It is an optional parameter.

IEEE address and ID within the RetrieveCallTraceStruct are mutually exclusive.
timeout : long - (Optional) The number of milliseconds to wait before receiving the results. If no results are received in the given time, the method returns.
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:
result : List (generic.CommonManagedEntityInformation) -
Exceptions:
calltrace.CallTraceJob.retrieveWlanGwUeCallTraceJobsException
Supported Network Elements
7750 SR Supported from 14.0.R1
  • Excluded chassis types: 7750-SR1 Fixed CFM, 7750 SR-1s, 7750-SRc12, 7750-SRc4, VSR-I
7705 SAR Gen 2
7450 ESS 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
7750 SR 20.0
7750 SR 21.0
7750 SR 22.0
7750 SR 23.0
7750 SR 24.0
7750 SR 25.0